Overview
Initiate a new payment. Payment can be initiated with either counterpartyId or counterparty details. For initiation with counterpartyId, counterpartyId field is mandatory. For initiation with counterparty details, creditorAccount and creditorName are mandatory. Providing both counterpartyId and counterparty details like creditorAddress will result in 400 Bad request response.
POST (/internal/v1/parties/{partyId}/payments)
Parameters
partyId (path) (required): The ID of the party that owns the accounts. See PartyId Model.
plmr-idempotency-key (header) (required): The idempotency key for the request. See plmrIdempotencyKey model.
X-Request-ID (header): Request id is used for tracing, if not provided, a new one will be generated. See xRequestId model.
plmr-mfa-challenge-id (header): MFA challenge id. See plmrMfaChallengeId model.
plmr-mfa-signature (header): MFA signature from 401 response. See plmrMfaSignature model.
plmr-user-action (header): Header used to indicate whether the request is user initiated request. When set to
true, the user session gets extended with the default session timeout. When set tofalse, or header is not present the user session is not extended. See plmrUserAction model.X-Device-Integrity-Token (header): Device integrity token obtains from Google/Apple. See xDeviceIntegrityToken model.
Authorization (header) (required): Authorization JWT access token obtained from keycloak. If the header is missing, has the wrong format or the token is expired an Unauthorized 401 response will be returned. See Authorization model.
Request Body
Responses
202 Accepted
Body of the response for a successful payment initiation request.
400 Bad Request
401 Unauthorized
401 response for operation that requires mfa
409 Conflict
423
500 Internal Server Error
Architecture
Generic Body for a payment initiation via JSON.
The Id of the counterparty.
36The Id of the payment method.
363635Details of the account from which the amount will be debited.
The ID of the account that will be debited.
ISO 4217 Alpha 3 currency code.
[A-Z]{3}ISO 4217 Alpha 3 currency code.
[A-Z]{3}The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78
-?[0-9]{1,14}(\.[0-9]{1,3})?Reference to a creditor account.
IBAN of an account.
[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}Basic Bank Account Number (BBAN) Identifier.
[a-zA-Z0-9]{1,30}Mobile phone number.
35In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type (e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.
Proprietary identification of the account.
35An entry provided by an external ISO code list.
35A scheme name defined in a proprietary way.
35A scheme name defined in a proprietary way.
35ExternalCashAccountType1Code from ISO 20022.
ISO 4217 Alpha 3 currency code.
[A-Z]{3}BICFI
[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}Creditor name.
70Name of a street or thoroughfare
Number that identifies the position of a building on a street
Name of the building or house
Floor or storey within a building
Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for
Building room number
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail
Name of a built-up area, with defined boundaries, and a local government
Specific location name within the town
Identifies a subdivision within a country sub-division
Identifies a subdivision of a country such as state, region, county
Nation with its own government. ISO 3166, Alpha-2 code
Name of a street or thoroughfare
Number that identifies the position of a building on a street
Name of the building or house
Floor or storey within a building
Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for
Building room number
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail
Name of a built-up area, with defined boundaries, and a local government
Specific location name within the town
Identifies a subdivision within a country sub-division
Identifies a subdivision of a country such as state, region, county
Nation with its own government. ISO 3166, Alpha-2 code
Unstructured remittance information.
140Specifies the payment type. Allowed values: - SEPA Instant payment ``` "paymentType": { "serviceLevel": "SEPA", "localInstrument": "INST", "categoryPurpose": null, "routingPreference": "INSTANT" } } ``` - SEPA Regular payment ``` "paymentType": { "serviceLevel": "SEPA", "localInstrument": "SCT", "categoryPurpose": null, "routingPreference": "NONE" } } ``` - SEPA Any payment ``` "paymentType": { "serviceLevel": "SEPA", "localInstrument": null, "categoryPurpose": null, "routingPreference": "NONE" } } ``` - Internal payment ``` "paymentType": { "serviceLevel": "INTERNAL", "localInstrument": "INTERNAL", "categoryPurpose": null, "routingPreference": "NONE" } } ``` - SWIFT payment ``` "paymentType": { "serviceLevel": "SDVA", "localInstrument": "SWIFT", "categoryPurpose": null, "routingPreference": "HIGH_PRIORITY" } } ``` - OTHER payment ``` "paymentType": { "serviceLevel": "OTHER", "localInstrument": "OTHER", "categoryPurpose": null, "routingPreference": "NONE" } } ```
Specifies the service level for the payment
SEPA INTERNAL SDVA OTHERSpecifies the local instrument for the payment. allowed values: OTHER, SWIFT, INTERNAL, SCT, INST
Specifies the category purpose for the payment
Specifies the routing preference for the payment
NONE HIGH_PRIORITY INSTANTAdditional information that cannot be captured in the structured elements and/or any other specific block.
No properties match your search
Try a different search term or clear the search to see all properties
Body of the response for a successful payment initiation request.
The payment status is filled with codes of the ISO 20022 data table: - 'ACCC': 'AcceptedSettlementCompleted' - Settlement on the creditor's account has been completed. - 'RCVD': 'Received' - Payment initiation has been received by the receiving agent. - 'RJCT': 'Rejected' - Payment initiation or individual transaction included in the payment initiation has been rejected.
ACCC RCVD RJCTResource identification of the generated payment initiation resource.
No properties match your search
Try a different search term or clear the search to see all properties
urn:plmr:payments:api:COUNTERPARTY_INVALID_NAME urn:plmr:payments:api:COUNTERPARTY_ALREADY_EXIST urn:plmr:payments:api:COUNTERPARTY_ACCOUNT_ALREADY_EXIST urn:plmr:payments:api:COUNTERPARTY_PAYMENT_METHOD_ALREADY_EXIST urn:plmr:payments:api:COUNTERPARTY_DETAILS_PROPERTIES_NOT_FOUND urn:plmr:payments:api:COUNTERPARTY_NOT_FOUND urn:plmr:payments:api:PAYMENT_METHOD_NOT_FOUND urn:plmr:payments:api:MISSING_PAYMENT_METHOD_ID urn:plmr:payments:api:INVALID_INIT_PAYMENT_WITH_COUNTERPARTY urn:plmr:payments:api:INVALID_STANDING_ORDER_WITH_COUNTERPARTY urn:plmr:payments:api:INTERNAL_SERVER_ERROR urn:plmr:payments:api:BAD_REQUEST urn:plmr:payments:api:RESOURCE_UNKNOWN urn:plmr:payments:api:UNAUTHORIZED urn:plmr:payments:api:FORBIDDEN urn:plmr:payments:api:INVALID_PARAM urn:plmr:payments:api:WEB_APPLICATION urn:plmr:payments:api:PAYMENT_NOT_FOUND urn:plmr:payments:api:INVALID_IBAN_BANK_IDENTIFIER urn:plmr:payments:api:INVALID_DEBTOR_IBAN urn:plmr:payments:api:INVALID_CREDITOR_IBAN urn:plmr:payments:api:INVALID_AMOUNT_CURRENCY urn:plmr:payments:api:INVALID_DEBTOR_ACCOUNT_CURRENCY urn:plmr:payments:api:INVALID_CREDITOR_ACCOUNT_CURRENCY urn:plmr:payments:api:START_DATE_IN_THE_PAST urn:plmr:payments:api:STANDING_ORDER_ALREADY_STARTED urn:plmr:payments:api:INVALID_ONE_TIME_SCHEDULE urn:plmr:payments:api:INVALID_RECURRENT_SCHEDULE urn:plmr:payments:api:STANDING_ORDER_NOT_FOUND urn:plmr:payments:api:STANDING_ORDER_EXECUTING urn:plmr:payments:api:NO_SCHEDULED_EXECUTIONS urn:plmr:payments:api:IDENTICAL_QUOTE_CURRENCIES urn:plmr:payments:api:NULL_CURRENCY_EXCHANGE_DETAILS urn:plmr:payments:api:AMOUNT_IS_TOO_SMALL urn:plmr:payments:api:CURRENCY_EXCHANGE_TIME_WINDOW_CLOSED urn:plmr:payments:api:INVALID_INSTRUCTED_AMOUNT_CURRENCY urn:plmr:payments:api:DEVICE_INTEGRITY_TOKEN_NOT_FOUNDurn:plmr:payments:api:NOT_BLANK urn:plmr:payments:api:NOT_NULL urn:plmr:payments:api:MUST_BE_NULL urn:plmr:payments:api:INVALID_FIELD_VALUE urn:plmr:payments:api:INVALID_END_DATE urn:plmr:payments:api:POSITIVENo properties match your search
Try a different search term or clear the search to see all properties
401 response for operation that requires mfa
urn:plmr:payments:api:MFA_REQUIRED3636MFA response details
Title: MFAChallenge
133636128128No properties match your search
Try a different search term or clear the search to see all properties
urn:plmr:payments:api:IDEMPOTENCY_ERRORNo properties match your search
Try a different search term or clear the search to see all properties
urn:plmr:payments:api:IDEMPOTENCY_ERRORNo properties match your search
Try a different search term or clear the search to see all properties
urn:plmr:payments:api:COUNTERPARTY_INVALID_NAME urn:plmr:payments:api:COUNTERPARTY_ALREADY_EXIST urn:plmr:payments:api:COUNTERPARTY_ACCOUNT_ALREADY_EXIST urn:plmr:payments:api:COUNTERPARTY_PAYMENT_METHOD_ALREADY_EXIST urn:plmr:payments:api:COUNTERPARTY_DETAILS_PROPERTIES_NOT_FOUND urn:plmr:payments:api:COUNTERPARTY_NOT_FOUND urn:plmr:payments:api:PAYMENT_METHOD_NOT_FOUND urn:plmr:payments:api:MISSING_PAYMENT_METHOD_ID urn:plmr:payments:api:INVALID_INIT_PAYMENT_WITH_COUNTERPARTY urn:plmr:payments:api:INVALID_STANDING_ORDER_WITH_COUNTERPARTY urn:plmr:payments:api:INTERNAL_SERVER_ERROR urn:plmr:payments:api:BAD_REQUEST urn:plmr:payments:api:RESOURCE_UNKNOWN urn:plmr:payments:api:UNAUTHORIZED urn:plmr:payments:api:FORBIDDEN urn:plmr:payments:api:INVALID_PARAM urn:plmr:payments:api:WEB_APPLICATION urn:plmr:payments:api:PAYMENT_NOT_FOUND urn:plmr:payments:api:INVALID_IBAN_BANK_IDENTIFIER urn:plmr:payments:api:INVALID_DEBTOR_IBAN urn:plmr:payments:api:INVALID_CREDITOR_IBAN urn:plmr:payments:api:INVALID_AMOUNT_CURRENCY urn:plmr:payments:api:INVALID_DEBTOR_ACCOUNT_CURRENCY urn:plmr:payments:api:INVALID_CREDITOR_ACCOUNT_CURRENCY urn:plmr:payments:api:START_DATE_IN_THE_PAST urn:plmr:payments:api:STANDING_ORDER_ALREADY_STARTED urn:plmr:payments:api:INVALID_ONE_TIME_SCHEDULE urn:plmr:payments:api:INVALID_RECURRENT_SCHEDULE urn:plmr:payments:api:STANDING_ORDER_NOT_FOUND urn:plmr:payments:api:STANDING_ORDER_EXECUTING urn:plmr:payments:api:NO_SCHEDULED_EXECUTIONS urn:plmr:payments:api:IDENTICAL_QUOTE_CURRENCIES urn:plmr:payments:api:NULL_CURRENCY_EXCHANGE_DETAILS urn:plmr:payments:api:AMOUNT_IS_TOO_SMALL urn:plmr:payments:api:CURRENCY_EXCHANGE_TIME_WINDOW_CLOSED urn:plmr:payments:api:INVALID_INSTRUCTED_AMOUNT_CURRENCY urn:plmr:payments:api:DEVICE_INTEGRITY_TOKEN_NOT_FOUNDurn:plmr:payments:api:NOT_BLANK urn:plmr:payments:api:NOT_NULL urn:plmr:payments:api:MUST_BE_NULL urn:plmr:payments:api:INVALID_FIELD_VALUE urn:plmr:payments:api:INVALID_END_DATE urn:plmr:payments:api:POSITIVENo properties match your search
Try a different search term or clear the search to see all properties